LotusScript Doc

Class: LSAAddrPersonData

Reference to all PersonalData in LSA-Contact

Version:
1.2.3, 25.JUL.2000
History:
24.JUL.2000RGRProperty Set Birthday changed to handle empty entries
24.JUL.2000RGRgetPersonData changed to handle new birthday property treatment



Property Summary
Public Property Set Birthday As Variant
Public Property Get Birthday As Variant
Public Property Get Company As String
Public Property Set ContactFunction As String
Public Property Get ContactFunction As String
Public Property Set Delimiter As String
Public Property Get Delimiter As String
Public Property Get Department As String
Public Property Set FirstName As String
Public Property Get FirstName As String
Public Property Set Gender As String
Public Property Get Gender As String
Public Property Set LastName As String
Public Property Get LastName As String
Public Property Set MiddleInitial As String
Public Property Get MiddleInitial As String
Public Property Set Nickname As String
Public Property Get Nickname As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant
Public Property Set Occupation As String
Public Property Get Occupation As String
Public Property Get Organization As String
Public Property Set OrganizationS As Variant
Public Property Get OrganizationS As Variant
Public Property Set Suffix As String
Public Property Get Suffix As String
Public Property Set Title As String
Public Property Get Title As String

Method Summary
Function CompareTo (CompItem As LSAAddrPersonData) As Integer
Sub Delete ()
Sub fillFromDoc (doc As NotesDocument)
Function getOrganizationData () As String
Function getPersonData () As String
Sub New (newFirstName As String, newLastName As String, newMiddleInitial As String, newTitle As String, newSuffix As String, newNickname As String, newGender As String, newBirthday As Variant, newFunction As String, newOccupation As String, newOrganizations As Variant)
Function saveToPredefinedFields (doc As NotesDocument) As Integer
Sub Validate ()

Property Detail

Public Property Set FirstName AsString

Sets the firstname of a contact person.

Summmary Top

Public Property Get FirstName AsString

Summmary Top

Public Property Set LastName AsString

Sets the lastname of a contact person.

Summmary Top

Public Property Get LastName AsString

Summmary Top

Public Property Set Birthday AsVariant

Sets the birthday of a contact person.

History:
24.JUL.2000RGRIf the information isn't a date the birthday is reset to empty
Summmary Top

Public Property Get Birthday AsVariant

Summmary Top

Public Property Set ContactFunction AsString

Sets the function of a contact person in an organization.

Summmary Top

Public Property Get ContactFunction AsString

Summmary Top

Public Property Set Gender AsString

Sets the gender of a contact person.

Summmary Top

Public Property Get Gender AsString

Summmary Top

Public Property Set MiddleInitial AsString

Sets the middle initial of a contact person.

Summmary Top

Public Property Get MiddleInitial AsString

Summmary Top

Public Property Set Nickname AsString

Sets the nickname of a contact person.

Summmary Top

Public Property Get Nickname AsString

Summmary Top

Public Property Set Occupation AsString

Sets the occupation of a contact person. which means what is the job of a person

Summmary Top

Public Property Get Occupation AsString

Summmary Top

Public Property Set Suffix AsString

Sets the suffix of a contact person in an organization.

Summmary Top

Public Property Get Suffix AsString

Summmary Top

Public Property Set Title AsString

Sets the title of a contact person in an organization.

Summmary Top

Public Property Get Title AsString

Summmary Top

Public Property Set OrganizationS AsVariant

Sets organizations the contact person is part of.

Summmary Top

Public Property Get OrganizationS AsVariant

Summmary Top

Public Property Get Organization AsString

Returns the first element of the OrganizationS property.

Summmary Top

Public Property Get Company AsString

Summmary Top

Public Property Get Department AsString

Summmary Top

Public Property Set Delimiter AsString

When the object is imploded to a serial data string this character is used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get Delimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to be use in the key property

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top
Method Detail

New

Public Sub New(newFirstName As String,newLastName As String,newMiddleInitial As String,newTitle As String,newSuffix As String,newNickname As String,newGender As String,newBirthday As Variant,newFunction As String,newOccupation As String,newOrganizations As Variant)
Instantiates a new object.

Parameters:
newFirstNameStringfirstname of the contact person
newLastNameStringlastname of the contact person
newMiddleInitialStringmiddle intial of the contact person
newTitleStringtitle of the contact person
newSuffixStringsuffix of the contact person
newNicknameStringnickname of the contact person
newGenderStringgender of the contact person
newBirthdayVariantbirthday of the contact person (Variant of DataType = 7, Date/Time)
newFunctionStringfunction of the contact person in an organization
newOccupationStringoccupation of the contact person (job)
newOrganizationVariantstring array with all organizations the contact is member in
Summmary Top

Delete

Public Sub Delete
Destructs the object

Summmary Top

getPersonData

Public Function getPersonData As String
Returns a serial data string of the form: ##LotusC#FirstName#LastName#MiddleInitial#Title#Suffix#Nickname# Gender#Birthday#Function#Occupation

Returns:
Stringserial data string as described above
History:
24.JUL.2000RGRif the birthday is empty udf-decodes the birthday as empty string ("""")
Summmary Top

getOrganizationData

Public Function getOrganizationData As String
Returns a serial data string of the form: ##LotusO#Organization#Company#Department###

Returns:
Stringserial data string as described above
Summmary Top

fillFromDoc

Public Sub fillFromDoc(doc As NotesDocument)
Given a NotesDocument, fills all attributes of the class by reading fields of the document. The fields in the document have to correspond to the fields of the form LSAContact in the template LSA-Address. The old values are set the values read from the document.

Returns:
docNotesDocument the document which containes the corresponding values
Summmary Top

saveToPredefinedFields

Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Saves the object to fields in the NotesDocument which is passed in as parameter. The fieldnames which are used correspond to the field names in the form LSAContact in the template LSB-Address.

Summmary Top

Validate

Public Sub Validate
Validates the object by checking if the attribute LastName of the object is empty.

Summmary Top

CompareTo

Public Function CompareTo(CompItem As LSAAddrPersonData) As Integer
Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:45:33 AM